Sends a list of events to the Insights API.

You can include up to 1,000 events in a single request,
but the request body must be smaller than 2&nbsp;MB.


Send events

Use this event to track when users add items to their shopping cart unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use this event.

To track add-to-cart events related to Algolia requests, use the "Added to cart object IDs after search" event.


Added to cart object IDs

Use this event to track when users add items to their shopping cart after a previous Algolia request.
If you're building your category pages with Algolia, you'll also use this event.


Added to cart object IDs after search

Use this event to track when users click facet filters in your user interface.

Clicked filters

Use this event to track when users click items unrelated to a previous Algolia request.
For example, if you don't use Algolia to build your category pages, use this event.

To track click events related to Algolia requests, use the "Clicked object IDs after search" event.


Clicked object IDs

Click event after an Algolia request.

Use this event to track when users click items in the search results.
If you're building your category pages with Algolia,
you'll also use this event.


Clicked object IDs after search

Converted filters

Use this event to track when users convert on items unrelated to a previous Algolia request.
For example, if you don't use Algolia to build your category pages, use this event.

To track conversion events related to Algolia requests, use the "Converted object IDs after search" event.


Converted object IDs

Use this event to track when users convert after a previous Algolia request.
For example, a user clicks on an item in the search results to view the product detail page.
Then, the user adds the item to their shopping cart.

If you're building your category pages with Algolia,
you'll also use this event.


Converted object IDs after search

Use this event to track when users make a purchase unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use this event.

To track purchase events related to Algolia requests, use the "Purchased object IDs after search" event.


Purchased object IDs

Use this event to track when users make a purchase after a previous Algolia request.
If you're building your category pages with Algolia, you'll also use this event.


Purchased object IDs after search

Use this method to capture active filters.
For example, when browsing a category page,
users see content filtered on that specific category.


Viewed filters

Use this event to track when users viewed items in the search results.

Viewed object IDs

Identifier for authenticated users.

When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`.
This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions.
Don't use personally identifiable information in user tokens.
For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).


Three-letter [currency code](https://www.iso.org/iso-4217-currency-codes.html).

Absolute value of the discount for this product, in units of `currency`.

Event name, up to 64 ASCII characters.

Consider naming events consistently—for example, by adopting Segment's
[object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework)
framework.


Applied facet filters.

Facet filters are `facet:value` pairs.
Facet values must be URL-encoded, such as, `discount:10%25`.


Index name (case-sensitive) to which the event's items belong.

Unique identifier for a search query, used to track purchase events with multiple records that originate from different searches.

Extra information about the records involved in a purchase or add-to-cart events.

If provided, it must be the same length as `objectIDs`.


Extra information about the records involved in a purchase or add-to-cart event.

If specified, it must have the same length as `objectIDs`.


Object IDs of the records that are part of the event.

Position of the clicked item the search results.

You must provide 1 `position` for each `objectID`.


Total price of a product, including any discounts, in units of `currency`.

Quantity of a product that has been purchased or added to the cart.
The total purchase value is the sum of `quantity` multiplied with the `price` for each purchased item.


Unique identifier for a search query.

The query ID is required for events related to search or browse requests.
If you add `clickAnalytics: true` as a search request parameter, the query ID is included in the API response.


Timestamp of the event, measured in milliseconds since the Unix epoch.
By default, the Insights API uses the time it receives an event as its timestamp.


Anonymous or pseudonymous user identifier.

Don't use personally identifiable information in user tokens.
For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).


Total monetary value of this event in units of `currency`.

Add-to-cart event after search or browse requests

Conversion event after search or browse requests

Purchase event after search or browse requests

insightsEvents

appId & apiKey

Success indicates that the Insights API received the events correctly, and that event properties are formatted correctly. Success doesn't imply that the event can be used by any Algolia feature. For example, the Insights API doesn't check if the index name you provided exists, or if the object IDs exist in your index.

Events successfully sent to the Insights API

This error doesn't return a JSON object, but HTML.

HTML

You need to provide your application ID using the `X-Algolia-Application-ID` header and your (search) API key with the `X-Algolia-API-Key` header.

Check, that you send events with the `POST` method.

Both objectIDs and filters attributes defined

This can happen if one or more attribute is a number instead of a string.

This can happen if you're sending an empty `events` array, or if you try to send a single event object instead of the `events` array.

This can happen if you try to send an array of events directly instead of using the `events` attribute.

Each event must include either the `objectIDs` or `filters` attribute.

Wrong combination of positions and eventType attributes

Click events with the `positions` attribute require the `queryID` attribute.

You can include up to 1,000 events in a single API request.

For click events with the `queryID` and `objectIDs` attributes, you must include the `positions` attribute with the same number of items as the `objectIDs` attribute.

Any value in the `positions` array must be greater than 0.

Algolia docs

Algolia is a platform for building powerful end-to-end search and discovery solutions.

Home

Algolia documentation

A short, step-by-step guide to learn Algolia basics.

Algolia Launchpad

Get Started with Launchpad

Create your first index and add records to make searchable in the next steps.

Import Your Data

Imorting Data

Build your search interface using the data you recently pushed to your Algolia index.

Design Your Results

Allow your users to search through your data based on the attributes you define here.

Add Searchable Attributes

Adding Searchable Attributes

Determine how your search results should be ranked based on index attributes and objectives.

Configure Relevancy

Configuring Search Relevancy

Create your search interface leveraging Algolia InstantSearch library.

Implement Search UI

Implement Search

Learn what Algolia's search API offers: speed, relevance, search, navigation, product and content discovery, and analytics.

What is Algolia?

NeuralSearch combines the precision of keyword matching with the deep understanding of natural language and contextual relevance provided by AI-based vector search.

NeuralSearch

Learn about the building blocks of Algolia's search engine, what Algolia offers, and the full ecosystem it provides.

How Algolia works

An overview of Algolia's ecosystem. API clients, UI libraries, integrations, the dashboard, and more.

Algolia's ecosystem

Learn how you can elevate your search and discovery experience with Algolia's out-of-the-box features.

Algolia's features

Terms used at Algolia and their definitions.

Algolia glossary

Unlock Algolia's most powerful features by collecting user events with the Insights API.

Get started

Get started with click and conversion events

How to send your data to Algolia, batch large datasets, synchronize with incremental updates and atomic reindexing, or handle concurrency.

Send and update your data

Relevancy from a high-level point of view - finding records, ranking, tie-breaking, typos, and other settings.

Relevance overview

Learn how you can use Algolia Recommend to display recommendations on your site or app.

Algolia Recommend

Use AI to automate finding the best synonyms for your search.

Dynamic Synonym Suggestions

Predict the categories to which a search query belongs with AI.

Query Categorization

Dynamic Re-Ranking automatically adjusts your ranking based on user trends.

Dynamic Re-Ranking

Learn how to use Dynamic Re-Ranking to re-rank and promote popular products on category pages.

Add Dynamic Re-Ranking to category pages

Overview

Python API client

Open source libraries for building search and discovery interfaces.

Autocomplete is an open source, production-ready JavaScript library for building search and discovery experiences.

API reference

Send events

Authorizations

Body

Response